package com.xuecheng.api.contant;

import com.xuecheng.api.contant.model.dto.TeachplanDTO;
import com.xuecheng.api.contant.model.vo.TeachplanVO;
import com.xuecheng.api.media.model.TeachplanMediaDTO;
import com.xuecheng.api.media.model.vo.BindTeachplanMediaVO;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;

/**
 * <p>
 *      课程计划服务API
 * </p>
 */
@Api(value = "课程计划信息管理")
public interface TeachplanApi {

    @ApiOperation("课程计划绑定媒资信息")
    TeachplanMediaDTO associateMedia(BindTeachplanMediaVO vo);


    /**
     * 根据Id查询出相关的课程计划并封装到TeachplanNode
     * @param courseId 课程基础信息id
     * @return TeachplanDTO 封装TeachplanNode
     */
    @ApiOperation(value = "根据课程Id查询课程计划树形结构（树形结构为三级目录）")
    @ApiImplicitParam(name = "courseId" , value = "课程Id值",required = true,dataType = "Long", paramType = "path", example = "1")
    TeachplanDTO queryTreeNodesByCourseId(Long courseId);

    /**
     * 新增或修改课程计划
     * @param teachplanVO 课程计划封装类型数据
     * @return teachplanDTO 课程计划封装类型返回数据
     */
    @ApiOperation("新增或修改课程计划")
    @ApiImplicitParam(name = "teachplanVO",value = "课程计划VO",
                      required = true,dataType = "TeachplanVO",paramType = "body")
    TeachplanDTO createOrModifyTeachPlan(TeachplanVO teachplanVO);


    /**
     * 根据课程计划id删除课程计划信息
     * @param teachPlanId 课程信息id
     */
    @ApiOperation(value = "删除课程计划")
    @ApiImplicitParam(name = "teachPlanId" ,
            value = "课程计划Id值",required = true,
            dataType = "Long", paramType = "path", example = "1")
    void removeTeachPlan(Long teachPlanId);
}